![]() |
CuDoubleSidedScannerAPI
1.11
|
Class that manages Scanner data and communication. More...
Public Types | |
| enum | ScannerEjectType |
| Eject type: which operation the paper form will perform during or after the scan job More... | |
| enum | ScannerPrintDensity |
| Scanner print density. Only for scanners that support print option More... | |
Public Member Functions | |
| CuScannerStatus | GetStatus () |
| Returns the current scanner status. More... | |
| String | GetFirmwareRelease () |
| Gets the current firmware release More... | |
| String | GetHardwareRelease () |
| Gets the current hardware release More... | |
| String | GetModelRelease () |
| Gets the current scanner model and release More... | |
| UInt32 | GetVoidPrintedPaperLen () |
| Get the lenght, in cm, of the total printed paper during "void" operations. (only for scanners with print option) More... | |
| UInt32 | GetScanCounter () |
| Get the number of the total scan jobs performed by the scanner. (only for scanners with print option) More... | |
| Byte [] | GetMagneticData () |
| Gets magnetic ink characters for CMC 7 standard. Scanner decodes magnetic data during a scan job More... | |
| void | TicketEject (ScannerEjectType ejectType) |
| */ More... | |
| void | LoadPaper () |
| Loads a ticket More... | |
| CImagesFromScannerContainer | ScanAndGetImage (CuScanParameters parameters) |
| Starts a scan job and gets the scanned image More... | |
| Boolean | CheckScanParameters (CuScanParameters parameters) |
| Checks if all the scan parameters are ok for this device. More... | |
| void | ResetScanner () |
| Performs an hardware scanner reset. Returns when the scanner is online More... | |
| ScannerCapability | GetScannerCapability () |
| Gets the scanner capabilities More... | |
| ScannerUltrasonicParameters | GetUltrasonicParameters () |
| Gets the scanner ultrasonic parameters (if supported by the device) from the RAM. More... | |
| void | SetUltrasonicParameters (ScannerUltrasonicParameters uparams) |
| Sets the scanner ultrasonic parameters (if supported by the device) into the RAM. More... | |
| CropParameters | GetCropParameters () |
| Gets the crop parameters. More... | |
| void | SetCropParameters (CropParameters cparams) |
| Sets the crop parameters. More... | |
| void | SetLedSettings (LedBarSetting ledSetting) |
| Set led bar working parameters More... | |
| void | UpdateScannerFirmware (String filePathAndName, Boolean checkFileValidity) |
| Performs a firmware update. This operation culd take several seconds. Don't call other scanner API during this operation. Returns when the scanner is online More... | |
| void | VoidTicketWithBitmap (Bitmap bBitmap, UInt32 offsetSteps, ScannerEjectType movementAfterVoid, ScannerPrintDensity printDensity) |
| Void / Brand the ticket with a Bitmap. (only for scanners with print option) More... | |
| void | SetBWThreshold (Byte bBWThreshold) |
| Sets the Threshold value for Black & White conversion More... | |
| Byte | GetBWThreshold () |
| Gets the Threshold value for Black & White conversion More... | |
| void | SetRejectMargins (Byte bRejectMarginL, Byte bRejectMarginR) |
| Sets the Reject Margins More... | |
| void | SetColorGammaCurvesCorrection (ColorGammaCurvesSetting colorGammaCurvesSetting) |
| Sets the Color Gamma Curves More... | |
| void | SetColorGammaCorrection (ColorGammaSetting colorGammaSetting) |
| Sets the Color Gamma (Works only with A4_Scanner) More... | |
Class that manages Scanner data and communication.
Scanner print density. Only for scanners that support print option
|
inline |
Checks if all the scan parameters are ok for this device.
| parameters | A CuScanParameters object that contains all scan parameters. |
| CuDoubleSidedScannerException |
|
inline |
Gets the Threshold value for Black & White conversion
| CeScannerCommException |
|
inline |
Gets the crop parameters.
| CuDoubleSidedScannerException |
|
inline |
Gets the current firmware release
| CuDoubleSidedScannerException |
|
inline |
Gets the current hardware release
| CuDoubleSidedScannerException |
|
inline |
Gets magnetic ink characters for CMC 7 standard. Scanner decodes magnetic data during a scan job
| CuDoubleSidedScannerException |
|
inline |
Gets the current scanner model and release
| CuDoubleSidedScannerException |
|
inline |
Get the number of the total scan jobs performed by the scanner. (only for scanners with print option)
| CuDoubleSidedScannerException |
|
inline |
Gets the scanner capabilities
| CuDoubleSidedScannerException |
|
inline |
Returns the current scanner status.
| CuDoubleSidedScannerException |
|
inline |
Gets the scanner ultrasonic parameters (if supported by the device) from the RAM.
| CuDoubleSidedScannerException |
|
inline |
Get the lenght, in cm, of the total printed paper during "void" operations. (only for scanners with print option)
| CuDoubleSidedScannerException |
|
inline |
Loads a ticket
| CuDoubleSidedScannerException |
|
inline |
Performs an hardware scanner reset. Returns when the scanner is online
| CuDoubleSidedScannerException |
|
inline |
Starts a scan job and gets the scanned image
| parameters | A CuScanParameters object that contains all scan parameters. |
| CuDoubleSidedScannerException |
|
inline |
Sets the Threshold value for Black & White conversion
| bBWThreshold | Black & White Threshold. |
| CeScannerCommException |
|
inline |
Sets the Color Gamma (Works only with A4_Scanner)
| colorGammaSetting | Class with the paramethers for set the Gamma Correction. |
| CeScannerCommException |
|
inline |
Sets the Color Gamma Curves
| colorGammaCurvesSetting | Class with the paramethers for set the Gamma Correction. |
| CeScannerCommException |
|
inline |
Sets the crop parameters.
| cparams | A CropParameters object that contains the crop parameters to sets. |
| CuDoubleSidedScannerException |
|
inline |
Set led bar working parameters
| ledSetting | Led settings to be set for led bar. |
| CuDoubleSidedScannerException |
|
inline |
Sets the Reject Margins
| bRejectMarginL | Left Margin for Reject. Each step corresponds to 32pixels.The value must be in the range 0-15 (0 default). |
| bRejectMarginR | Right Margin for Reject. Each step corresponds to 32pixels.The value must be in the range 0-15 (0 default). |
| CeScannerCommException |
|
inline |
Sets the scanner ultrasonic parameters (if supported by the device) into the RAM.
| uparams | A ScannerUltrasonicParameters object that contains the ultrasonic parameters to sets. |
| CuDoubleSidedScannerException |
|
inline |
*/
Performs a ticket eject or retract
| ejectType | Eject type: select whether to eject (move over the scanner) or retract (move back to the user) the ticket |
| CuDoubleSidedScannerException |
|
inline |
Performs a firmware update. This operation culd take several seconds. Don't call other scanner API during this operation. Returns when the scanner is online
| filePathAndName | Update file name and path |
| checkFileValidity | If true, the API will check the file validity before start update the firmware. Using true is ADVISED. Use false only when strictly necessary. |
| CuDoubleSidedScannerException |
|
inline |
Void / Brand the ticket with a Bitmap. (only for scanners with print option)
| bBitmap | Bitmap image to print |
| offsetSteps | Offset to perform before to print, in dots |
| movementAfterVoid | The movement the ticket must perform after being voided: to be ejected forward, retracted backward, or kept hold for further commands by the user |
| printDensity | Print Density |
| CeScannerCommException |